[DEPRECATED] Add a signer to document
[DEPRECATED — will stop working in API v2] This endpoint is kept for backwards compatibility. Use POST /api/v1/documents/:id/parties instead — “party” is the correct term for a document participant.
Add a signer/participant to a document. The signer must reference an existing contact.
Signer Roles:
SIGNER- Must sign the documentORGANIZER- Document organizer (no signature required)REVIEWER- Reviews document (no signature required)ACCEPTOR- Deprecated. Still accepted on input but stored asSIGNER; never returned. Removed in v2.
Per-Signer Settings:
deliveryMethod- How to notify:EMAIL(default),SMS, orNONE(use signing URL directly)requiredSignature- Signature type:DRAWING,BANKID(Swedish BankID),CLICK_TO_SIGN,MANUAL, or a national eID scheme. eID schemes are switched on market by market — callGET /api/v1/helpers/signature-methodsfor the set your account can actually use rather than hard-coding a listtwoStepVerification- identity gate passed BEFORE the document opens:NONE(default),PIN_BEFORE_SIGNING,SMS_BEFORE_SIGNING,EMAIL_BEFORE_SIGNING, or an eID gate such asBANKID_BEFORE_SIGNING— callGET /api/v1/helpers/two-step-verificationsfor the live list
Signing Order: For SEQUENTIAL signing, specify the order (1, 2, 3…). For PARALLEL signing, order is ignored.
Response: Returns the created signer. Use GET /documents/:id/signers/:signerId to retrieve the signing URL.
Authorizations
Personal API key, e.g. Authorization: Bearer sajn_sk_.... Not scope-limited — acts as the issuing user.
Headers
Bearer token for API authentication
Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.
255Path Parameters
Body
Body
Create signer request
ID of the contact to add as a signer
1Party role: SIGNER, ORGANIZER, or REVIEWER. (ACCEPTOR is deprecated and treated as SIGNER.)
Signing order for sequential signing (ignored for parallel)
How to send to this signer: EMAIL (default), SMS, or NONE
EMAIL, SMS, NONE, IN_APP Signature type required: DRAWING (default), BANKID, or CLICK_TO_SIGN
NONE, DRAWING, SE_BANKID, MANUAL, CLICK_TO_SIGN, NO_BANKID_BIOMETRIC, NO_BANKID_HIGH, NO_QES, DK_MITID, DK_MITID_ERHVERV, FI_FTN, NL_IDIN Two-step verification: NONE (default), SMS_BEFORE_SIGNING, EMAIL_BEFORE_SIGNING, or BANKID_BEFORE_SIGNING
NONE, SMS_BEFORE_SIGNING, EMAIL_BEFORE_SIGNING, PIN_BEFORE_SIGNING, SE_BANKID_BEFORE_SIGNING, NO_BANKID_BIOMETRIC_BEFORE_SIGNING, NO_BANKID_HIGH_BEFORE_SIGNING, DK_MITID_BEFORE_SIGNING, DK_MITID_ERHVERV_BEFORE_SIGNING, FI_FTN_BEFORE_SIGNING, NL_IDIN_BEFORE_SIGNING Response
200
Unique signer identifier
Document ID this signer belongs to
Signer full name
Signer role: SIGNER, ORGANIZER, or REVIEWER
SIGNER, ORGANIZER, REVIEWER Date and time when the signer signed (null if not signed)
Read status: NOT_OPENED, OPENED, or READ
NOT_OPENED, OPENED, READ Signing status: NOT_SIGNED, SIGNED, or REJECTED
NOT_SIGNED, SIGNED, REJECTED How documents are sent to this signer: EMAIL, SMS, or NONE
EMAIL, SMS, NONE, IN_APP Signature type required: DRAWING, BANKID, CLICK_TO_SIGN, etc.
NONE, DRAWING, BANKID, MANUAL, CLICK_TO_SIGN, NO_BANKID_BIOMETRIC, NO_BANKID_HIGH, NO_QES, DK_MITID, DK_MITID_ERHVERV, FI_FTN, NL_IDIN Two-step verification: NONE, SMS_BEFORE_SIGNING, EMAIL_BEFORE_SIGNING, or BANKID_BEFORE_SIGNING
NONE, PIN_BEFORE_SIGNING, SMS_BEFORE_SIGNING, EMAIL_BEFORE_SIGNING, BANKID_BEFORE_SIGNING, NO_BANKID_BIOMETRIC_BEFORE_SIGNING, NO_BANKID_HIGH_BEFORE_SIGNING, DK_MITID_BEFORE_SIGNING, DK_MITID_ERHVERV_BEFORE_SIGNING, FI_FTN_BEFORE_SIGNING, NL_IDIN_BEFORE_SIGNING Send status: NOT_SENT, SENT, DELIVERED, BOUNCED, or FAILED
NOT_SENT, SENT, DELIVERED, BOUNCED, FAILED True when an eID verified this signer — either by signing with one or by passing an eID verification gate.
True when an eID completed, the identity did not match the intended signer, and the signature was still recorded — read GET /api/v1/documents/{id}/signatures to see what differed. Stays false when the workspace requires an SSN match to sign and the attempt was refused, because no signature exists; those attempts appear only in the document audit trail.
Signer email address
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Signer phone number (for SMS notifications)
Company name
Role/title within the company
Company organization number
Your external reference ID for this signer
Linked company ID
National identity number supplied by the sender when creating the document. Optional — BankID works without it, falling back to a name check. This is input and is never overwritten with what the eID verified: read the verified identity from GET /api/v1/documents/{id}/signatures.
ISO 3166-1 alpha-3 country code for the signer (e.g. SWE)
Order for sequential signing (null for parallel)

